API Documentation
BitStream.h
1 // BitStream.h
3 //
5 
6 namespace nkMemory
7 {
11  class BitStream
12  {
13  public :
14 
15  // Constructor, destructor
26 
27  // Getters
31  BufferView<> getData () const ;
35  unsigned char getCurrentByte () const ;
39  unsigned int getByteCounter () const ;
45  unsigned int getBitCounter () const ;
51  bool isAtEos () const ;
52 
53  // Controls
63  unsigned int peekMsb (unsigned int count) ;
73  unsigned int peekLsb (unsigned int count) ;
80  unsigned int readMsb (unsigned int count) ;
87  unsigned int readLsb (unsigned int count) ;
93  void moveForward (unsigned int count) ;
98  void moveToNextByte () ;
105  void moveTo (unsigned int byteCount, unsigned int bitCount) ;
109  void rewind () ;
110  } ;
111 }
nkMemory::BitStream::isAtEos
bool isAtEos() const
nkMemory::BitStream::moveToNextByte
void moveToNextByte()
nkMemory::BitStream
Offers capabilities to read data bit per bit.
Definition: BitStream.h:12
nkMemory::BitStream::readMsb
unsigned int readMsb(unsigned int count)
nkMemory::BufferView
A view over data.
Definition: BufferView.h:18
nkMemory::BitStream::rewind
void rewind()
nkMemory::BitStream::getCurrentByte
unsigned char getCurrentByte() const
nkMemory::BitStream::getBitCounter
unsigned int getBitCounter() const
nkMemory::BitStream::peekMsb
unsigned int peekMsb(unsigned int count)
nkMemory::BitStream::getByteCounter
unsigned int getByteCounter() const
nkMemory::BitStream::peekLsb
unsigned int peekLsb(unsigned int count)
nkMemory::BitStream::BitStream
BitStream(BufferView<> data)
nkMemory::BitStream::getData
BufferView getData() const
nkMemory::BitStream::~BitStream
~BitStream()
nkMemory::BitStream::readLsb
unsigned int readLsb(unsigned int count)
nkMemory::BitStream::moveTo
void moveTo(unsigned int byteCount, unsigned int bitCount)
nkMemory::BitStream::moveForward
void moveForward(unsigned int count)
nkMemory
Encompasses all API of component NilkinsMemory.
Definition: Allocator.h:7